User Manual

Table of Contents

• Introduction to Cyclone

• Cyclone for C Programmers

  • Getting Started
  • Pointers
  • Regions
  • Arrays
  • Structs
  • Unions
  • C++, GCC and C99 Additions
  • Additional Features of Cyclone
  • Exceptions
  • Let Declarations and Pattern Matching
  • Subtyping
  • Polymorphic Functions
  • Polymorphic Data Structures
  • Abstract and Existential Types
  • Restrictions

• Pointers

  • Pointer Subtyping
  • Pointer Coercions
  • Default Region Qualifiers
  • Static Expression Bounds

• Tagged Unions and Datatypes

  • Tagged Unions
  • Datatypes
  • The Tagof Operator
  • Extensible Datatypes

• Pattern Matching

  • Let Declarations
  • Pattern Forms
  • Switch Statements

• Type Inference

• Polymorphism

• Memory Management Via Regions
  • Introduction to Regions
  • Region Allocation
  • Region Common Uses
  • Type-Checking Regions

• Pointers with Restricted Aliasing

  • Introduction
  • Allocation and Freeing
  • Unique Pointers
  • Reference-counted Pointers
  • Qualifier Polymorphism
  • Aliasing Unique Pointers
  • Dynamic Regions
  • Defaults and Shorthands
  • Subtyping for Effect Qualifier and Reaps
  • Reap Allocator Implementation

• Namespaces

• Varargs

• Definite Assignment

• Advanced Features

  • Existential types
  • The Truth About Effects, Capabilities and Effect Subset Constraints
  • Interprocedural Memory Initialization

• Porting C code to Cyclone

  • Semi-Automatic Porting
  • Manually Translating C to Cyclone
  • Interfacing to C

• Frequently Asked Questions

• Libraries

  • C Libraries
  • <array.h>
  • <bitvec.h>
  • <buffer.h>
  • <core.h>
  • <dict.h>
  • <filename.h>
  • <fn.h>
  • <graph.h>
  • <hashtable.h>
  • <iter.h>
  • <list.h>
  • <pp.h>
  • <queue.h>
  • <rope.h>
  • <set.h>
  • <slowdict.h>
  • <xarray.h>

• Language Summary

• Installing Cyclone

• Tools

  • The compiler
  • The lexer generator
  • The parser generator
  • The allocation profiler, aprof
  • The C interface tool, buildlib